home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / galery11.zip / GALLERY.DOC < prev    next >
Text File  |  1991-12-10  |  18KB  |  424 lines
  1.   GALLERY.DOC                                                  Page 1 of 8
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                  ******************************************
  8.                  *                                        *
  9.                  *              GALLERY.EXE               *
  10.                  *                                        *
  11.                  * Created 3/12/90 by Avatar (Andrew Pam) *
  12.                  *   Sysop of S.I.G. BBS +61 3 888-8846   *
  13.                  *                                        *
  14.                  *        Ver 1.1 written 10/12/91        *
  15.                  * Copyright (c) 1991 Serious Cybernetics *
  16.                  *                                        *
  17.                  ******************************************
  18.  
  19.  
  20.  
  21.  
  22.  
  23.                              Table of Contents
  24.                              ~~~~~~~~~~~~~~~~~
  25.  
  26.            Table of Contents  . . . . . . . . . . . . . . . . . 1
  27.  
  28.            Legal Notice . . . . . . . . . . . . . . . . . . . . 2
  29.  
  30. |          Vertical Bars  . . . . . . . . . . . . . . . . . . . 2
  31.  
  32.            Introduction . . . . . . . . . . . . . . . . . . . . 2
  33.  
  34.            Installation . . . . . . . . . . . . . . . . . . . . 3
  35.  
  36.            Status Line  . . . . . . . . . . . . . . . . . . . . 4
  37.  
  38.            Local Commands . . . . . . . . . . . . . . . . . . . 4
  39.  
  40.            Control Characters . . . . . . . . . . . . . . . . . 4
  41.  
  42.            Using Gallery  . . . . . . . . . . . . . . . . . . . 5
  43.  
  44.            The Main Menu  . . . . . . . . . . . . . . . . . . . 5
  45.  
  46.            The Category Menus . . . . . . . . . . . . . . . . . 5
  47.  
  48.            Viewing A Picture  . . . . . . . . . . . . . . . . . 5
  49.  
  50.            Customising Gallery  . . . . . . . . . . . . . . . . 6
  51.  
  52.            ANSI codes supported . . . . . . . . . . . . . . . . 7
  53.  
  54.            Colours  . . . . . . . . . . . . . . . . . . . . . . 8
  55.  
  56.            Technical Notes  . . . . . . . . . . . . . . . . . . 8
  57.  
  58.            Future Enhancements  . . . . . . . . . . . . . . . . 8
  59.  
  60.   GALLERY.DOC                                                  Page 2 of 8
  61.  
  62.   Legal Notice
  63.   ~~~~~~~~~~~~
  64.  
  65.   This program is Shareware.  You may distribute it as widely as you wish.
  66. | You may not modify GALLERY.EXE, the update history GALLERY.NEW or this
  67. | file GALLERY.DOC in any way, nor may you omit any of them or the sample
  68. | GALLERY.CTL file.  You may not include any other files as part of the
  69. | Gallery distribution package, and you may not charge more than a fair
  70. | and reasonable copying fee.  If you continue using this program on an
  71. | ongoing basis after having tested it, you must send $5 (A$10 or
  72. | equivalent in foreign currency if outside Australia) or more to the
  73. | address at the end of this documentation with your name and (if a Sysop)
  74. | the name of your bulletin board.
  75.  
  76.   You will receive a disk containing the latest version of the program
  77.   registered in your name and a selection of other Freeware and Shareware
  78.   software from Serious Cybernetics.  Please specify the size and shape of
  79.   disk you require when ordering.  No warranty of any kind is expressed or
  80.   implied, and the author will not be held liable for any damages,
  81.   consequential or otherwise, caused by the use, misuse or abuse of this
  82.   program.  We told you the rules, now don't forget them!  Failure to
  83.   abide by these terms constitutes a breach of copyright law.  Nyaah!
  84.  
  85.  
  86.  
  87. | Vertical Bars
  88.   ~~~~~~~~~~~~~
  89.  
  90. | Lines in this document with a vertical bar "|" in the left margin have
  91. | been added or modified since the original version 1.0 release.
  92.  
  93.  
  94.  
  95.   Introduction
  96.   ~~~~~~~~~~~~
  97.  
  98.   I decided to write Gallery as a replacement for the rather cumbersome
  99.   arrangement of menus I had created to display a selection of ANSI
  100.   pictures for the amusement of the users on my BBS.  In addition to
  101.   saving me a great deal of time and trouble maintaining these menus every
  102.   time I wanted to add or remove a picture from my collection, I also
  103.   decided to make it possible to optionally store all the pictures in a
  104.   single archive using any popular archiving program.  This can reduce the
  105.   amount of space needed to store the pictures by over 70 percent!
  106.  
  107.   Gallery is primarily intended for use on bulletin boards, but it can
  108.   also be used without a bulletin board as a simple and convenient way to
  109.   store and view your own collection of ANSI pictures.  Share and enjoy!
  110.  
  111.   GALLERY.DOC                                                  Page 3 of 8
  112.  
  113.   Installation
  114.   ~~~~~~~~~~~~
  115.  
  116.   Gallery is designed to work with all bulletin board software.  It does
  117. | not require access to any files maintained by the BBS, but it is
  118. | capable of reading RBBS style DOORINFO.DEF or DORINFOn.DEF files (also
  119. | used by Remote Access, SuperBBS and QuickBBS), WWIV style CHAIN.TXT
  120. | files, Wildcat style CALLINFO.BBS files and GAP style DOOR.SYS files.
  121. | Multi-user operation is now fully supported.
  122.  
  123.   For a summary of the command line parameters, run GALLERY.  This will
  124.   produce the following usage guide:
  125.  
  126.   Usage:   GALLERY {options...} {username} {options...}
  127.  
  128.   Options: /<baud>  where <baud> = 0 for local
  129.            /<port>  where <port> = 1 to 4
  130. |          /G<ANSI> where <ANSI> = 0 to 3
  131. |          /L<rows> where <rows> = length of user's screen (12 to 60)
  132. |          /N<line> where <line> = BBS line number (1 to 99)
  133. |          /T<time> where <time> = max time in Gallery (minutes)
  134. |          /W<name> where <name> = filename of WWIV style chain file
  135.  
  136. |          /D => read GAP style DOOR.SYS file
  137. |          /R => read RBBS style DORINFOn.DEF file
  138. |          /W => read Wildcat style CALLINFO.BBS file
  139.  
  140.   To use Gallery locally, the only parameter required is your name, since
  141.   Gallery defaults to local operation with ANSI colour enabled.  A baud
  142.   rate other than zero will enable remote operation using the specified
  143.   communications port.  It is a fatal error to specify a non-initialised,
  144.   disconnected or otherwise invalid port since Gallery assumes that a user
  145.   is already online and makes no attempt to check that the port is
  146.   operational.
  147.  
  148. | The /D, /R and /W parameters will automatically determine the user's
  149. | name, baud rate, port, ANSI capability and time remaining, so no other
  150. | parameters are required when they are is used; this is therefore the
  151. | recommended option where possible.  However, the other options will
  152. | override these settings if placed later on the command line.  The /G,
  153. | /G0 and /G2 options will disable ANSI facilities and use only standard
  154. | ASCII text, which will cause Gallery to exit with the message "This
  155. | program requires ANSI graphics capability."  The /T option will limit
  156. | the amount of time that the user can spend in Gallery.  The user will
  157. | never be allowed more than half an hour in Gallery in any case, or ten
  158. | minutes if Gallery has not been registered.
  159.  
  160.   The use of a FOSSIL (Fido-Opus-Seadog Standard Interface Layer)
  161.   communications driver such as David Nugent's BNU or Ray Gwinn's X00 is
  162.   highly recommended when using Gallery remotely, especially at speeds of
  163.   2400 BPS and higher.  Characters are unlikely to be lost at normal
  164.   typing speeds, but if macros are used at the higher speeds they are very
  165.   likely to lose characters if a FOSSIL is not used.  Gallery will
  166.   automatically detect the presence of a FOSSIL.
  167.  
  168.   GALLERY.DOC                                                  Page 4 of 8
  169.  
  170.   Status Line
  171.   ~~~~~~~~~~~
  172.  
  173.   While Gallery is running a status line will be displayed on the bottom
  174.   line of the screen in reverse video.  From left to right, the status
  175.   line gives the following information:
  176.  
  177.   * The version number of this release of Gallery
  178.   * LOCAL or the current communication port and baud rate
  179.   * The current user's full name (if known)
  180.   * LOG if Gallery is currently logging the chat to CHAT.LOG
  181.   * The time left in Gallery, or [CHATTING]
  182.  
  183.  
  184.  
  185.   Local Commands
  186.   ~~~~~~~~~~~~~~
  187.  
  188.   The following local commands are currently provided by Gallery:
  189.  
  190.   Alt-C   Chat mode
  191.   Alt-J   Jump to DOS
  192.   Alt-L   Logging toggle (in chat mode)
  193.   PageUp  Add one minute to time left in Gallery
  194.   PageDn  Subtract one minute from time left in Gallery
  195.   Escape  Terminate chat (in chat mode).
  196.  
  197.  
  198.  
  199.   Control Characters
  200.   ~~~~~~~~~~~~~~~~~~
  201.  
  202.   The following control characters are currently supported by Gallery:
  203.  
  204.   Crtl-G  Bell            (does not ring at local console
  205.                            when entered by remote user except in chat)
  206.   Ctrl-H  Backspace       (will not backspace beyond first column)
  207.   Ctrl-I  Tab             (uses standard 8 character tab stops)
  208.   Ctrl-J  Line Feed       (scrolls at bottom of screen)
  209.   Ctrl-K  Reverse LF      (will not move beyond top of screen)
  210.   Ctrl-L  Clear Screen
  211.   Ctrl-M  Carriage Return
  212.   Ctrl-N  Home Cursor     (moves cursor to top left corner)
  213. | Ctrl-O  Cursor to EOL   (moves cursor to end of current line)
  214. | Ctrl-R  Redraw Screen   (only if entered by remote user)
  215.   Ctrl-U  Cursor Forward  (will not move beyond last column)
  216.   Ctrl-X  Cancel          (deletes the entire line)
  217.  
  218. | All escape sequences from the user except ANSI/VT100 cursor movements
  219. | are currently ignored.  The "arrow" cursor keys are fully supported and
  220. | the Home, Ctrl-Home and End keys perform Ctrl-N, Ctrl-L and Ctrl-O
  221. | respectively.
  222.  
  223.   GALLERY.DOC                                                  Page 5 of 8
  224.  
  225.   Using Gallery
  226.   ~~~~~~~~~~~~~
  227.  
  228.   When entering Gallery, the first thing you will see is the copyright
  229. | notice and a single line of instructions.  Press any key when you have
  230. | finished absorbing this riveting information.  :-)
  231.  
  232.  
  233.  
  234.   The Main Menu
  235.   ~~~~~~~~~~~~~
  236.  
  237.   You will now see a list of all the available categories.  At the bottom
  238.   will be the amount of time you have left in minutes and the prompt
  239.   "Select:".  You may type the number next to any of the categories listed
  240. | to select that category or X to exit Gallery.  Any other key will have
  241. | no effect and cause a "beep" to let you know you goofed.
  242.  
  243.  
  244.  
  245.   The Category Menus
  246.   ~~~~~~~~~~~~~~~~~~
  247.  
  248.   After selecting a category, you will see a list of all the pictures in
  249.   that category with their filenames and descriptions.  Once again your
  250.   remaining time and the "Select:" prompt will be displayed at the bottom.
  251.   You may type the letter next to any of the pictures to display that
  252. | picture or minus "-" to quit back to the Main Menu of Gallery.
  253.  
  254.  
  255.  
  256.   Viewing A Picture
  257.   ~~~~~~~~~~~~~~~~~
  258.  
  259. | When viewing a picture, you may press the "P" or Ctrl-S key to pause
  260. | (any key will continue) or the "S" key or Ctrl-C to abort the picture if
  261. | you don't want to see the rest of it.  Some pictures which are longer
  262. | than 24 lines will not display properly on the local screen in 25-line
  263. | video modes because of the status line, but will nonetheless look just
  264. | fine to a remote user if they have enough lines on their display.
  265.  
  266. | Some communications programs also have various bugs which may prevent
  267. | some pictures from being displayed properly; in particular, Telix
  268. | doesn't like the Ctrl-P character (a triangle pointing right), most
  269. | programs will not display the "Del" character (a little house), and some
  270. | programs have trouble wrapping lines at the right edge of the screen.
  271.  
  272.   GALLERY.DOC                                                  Page 6 of 8
  273.  
  274.   Customising Gallery
  275.   ~~~~~~~~~~~~~~~~~~~
  276.  
  277.   Gallery uses a file called GALLERY.CTL to describe the pictures.  If
  278.   this file is not present or readable when Gallery is run, it will exit
  279. | with the message "*** Unable to open GALLERY.CTL ***" and errorlevel 2.
  280.   If Gallery can't read a description of at least one picture in the file
  281.   it will exit with the message "*** No descriptions in GALLERY.CTL ***".
  282.   GALLERY.CTL is an ASCII text file and can be edited with any text editor
  283.   of your choice.  The sample GALLERY.CTL provided with this program is
  284. | suitable for use with the ANSIPICS.ARJ collection available for viewing,
  285.   downloading or file requests from S.I.G. BBS on +61 3 888-8846.
  286.  
  287.   The first line of the file should be the full drive, path and name
  288.   (including extension) of the archiving program to use with any
  289.   parameters necessary and the drive, path and name of the archive
  290. | containing the pictures.  E.g: "C:\UTILS\ARJ.EXE E ANSIPICS" will use
  291. | ARJ in the C:\UTILS directory to unarchive ANSIPICS.ARJ in the current
  292. | directory when Gallery is run.  If you do not wish to store your
  293.   pictures in an archive just leave the first line of GALLERY.CTL blank.
  294.  
  295.   The current directory when Gallery is run will be used to store the
  296.   pictures temporarily while displaying them - unless the environment
  297.   variable "TMP" exists, in which case the value of TMP will be used as
  298.   the temporary directory.  E.g: "SET TMP=M:\" where M: is a RAMdisk.
  299.  
  300.   The rest of the GALLERY.CTL file contains a group of lines for each
  301.   category of pictures.  Each group must be separated by at least one
  302.   blank line.  If there are more categories than Gallery can handle
  303.   (currently ten) it will ignore the remaining lines.  The first line of
  304.   each group must be the description of the category in a maximum of fifty
  305.   characters.
  306.  
  307.   All the other lines in a group must begin with the filename of a picture
  308.   in that category (the extension defaults to .ANS if not given), at least
  309.   one space, and the description of the picture in no more than fifty
  310.   charaters.  If you are not storing the pictures in an archive, the
  311.   drive and path should be given or it will default to the current
  312.   directory at the time Gallery is run.  If there are more pictures in a
  313.   category than Gallery can handle (currently twenty) it will ignore any
  314.   pictures after the twentieth.
  315.  
  316.   GALLERY.DOC                                                  Page 7 of 8
  317.  
  318.   ANSI codes supported
  319.   ~~~~~~~~~~~~~~~~~~~~
  320.  
  321.   <ESC> [A                     Move cursor up one line
  322.   <ESC> [#A                    Move cursor up # lines
  323.   <ESC> [B                     Move cursor down one line
  324.   <ESC> [#B                    Move cursor down # lines
  325.   <ESC> [C                     Move cursor right one character
  326.   <ESC> [#C                    Move cursor right # characters
  327.   <ESC> [D                     Move cursor left one character
  328.   <ESC> [#D                    Move cursor left # characters
  329.   <ESC> [H    or <ESC> [f      Home cursor
  330.   <ESC> [#H   or <ESC> [#f     Move cursor to row #
  331.   <ESC> [#;#H or <ESC> [#;#f   Move cursor to row # column #
  332.   <ESC> [J    or <ESC> [#J     Clear screen and home cursor
  333.   <ESC> [K    or <ESC> [#K     Clear to end of current line
  334.   <ESC> [m                     Reset colours to light grey on black
  335.   <ESC> [#{;#...}m             Change colours (see below)
  336.   <ESC> [s                     Save current cursor position
  337.   <ESC> [u                     Restore cursor position
  338.  
  339.   Rows and columns are numbered starting from one.  The following numbers
  340.   are supported for the <ESC> [#m code:
  341.  
  342.   0       Reset colours to light gray on black
  343.   1       Set foreground colour to highlighted (bright colours)
  344. | 2       Set foreground colour to normal (dim colours)
  345. | 3       Set foreground colour to blue (italics on some terminals)
  346.   4       Set foreground colour to blue (underlined on monochrome systems)
  347.   5       Set foreground colour to blinking
  348. | 6       Set foreground colour to blinking (fast blink on some terminals)
  349.   7       Set colours to black on light grey (reverse video)
  350.   8       Set colours to black on black (invisible!)
  351.   30      Set foreground colour to black
  352.   31      Set foreground colour to red
  353.   32      Set foreground colour to green
  354.   33      Set foreground colour to brown (yellow when bright)
  355.   34      Set foreground colour to blue
  356.   35      Set foreground colour to purple
  357.   36      Set foreground colour to cyan
  358.   37      Set foreground colour to white
  359.   40      Set background colour to black
  360.   41      Set background colour to red
  361.   42      Set background colour to green
  362.   43      Set background colour to brown
  363.   44      Set background colour to blue
  364.   45      Set background colour to purple
  365.   46      Set background colour to cyan
  366.   47      Set background colour to white
  367.  
  368.   GALLERY.DOC                                                  Page 8 of 8
  369.  
  370.   Colours
  371.   ~~~~~~~
  372.  
  373.   The following colours are used by Gallery:
  374.  
  375.   Light Grey      Default colour
  376.   White           System messages, menu prompts
  377.   Cyan            Characters typed by user, picture descriptions
  378. | Purple          [ENTER] prompts
  379.   Yellow          Characters typed by sysop, user choices
  380.   Light Red       Fatal error messages
  381. | Light Green     Exit choice on menus
  382.   Light Blue      Filenames in menus
  383.   Light Cyan      Menu titles
  384.  
  385.   These colours are not currently customisable.
  386.  
  387.  
  388.  
  389.   Technical Notes
  390.   ~~~~~~~~~~~~~~~
  391.  
  392.   Gallery provides a wordwrap facility superior to the one in the Remote
  393.   Access internal chat routines.  Although Gallery will read the BIOS row
  394.   and column information and work correctly on any text resolution with at
  395.   least 80 columns (I often use 132 columns by 60 rows) the wordwrap will
  396.   always ensure that text is wrapped after column 79 to match user
  397.   displays.  Words longer than 20 characters will not be wrapped.
  398.  
  399.   The Alt-J Jump to DOS facility will swap most of Gallery to EMS (if
  400.   available) or disk, leaving only about 7K of RAM in use.
  401.  
  402.   All I/O is done strictly through DOS and BIOS calls without any direct
  403.   hardware access whatsoever, so it should work with any PC system
  404.   compatible at the BIOS level, which is just about everything these days.
  405. | Gallery will also relinquish time slices to multitaskers when possible.
  406.  
  407.  
  408.  
  409.   Future Enhancements
  410.   ~~~~~~~~~~~~~~~~~~~
  411.  
  412.   If you have any further suggestions or comments, feel free to leave a
  413.   message to "Avatar" on my bulletin board, E-mail me as Avatar on
  414. | 199:4242/1@RainbowNet, 3:632/358@FidoNet or 58:4100/32@INTLnet,
  415.   "avatar@csource.oz.au" on the Internet or write to:
  416.  
  417.           Serious Cybernetics
  418.           P.O. Box 409
  419.           Canterbury VIC 3126
  420.           Australia
  421.  
  422.   This program was brought to you courtesy of S.I.G. BBS on +61 3 888-8846
  423.   Share and enjoy!
  424.